powerstep.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef POWERSTEP_H
#define POWERSTEP_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"




#define POWERSTEP_DIR_CW                        0
#define POWERSTEP_DIR_CCW                       1

#define POWERSTEP_PIN_LOW_LEVEL                 0
#define POWERSTEP_PIN_HIGH_LEVEL                1

#define POWERSTEP_SPEED_VERY_SLOW               0
#define POWERSTEP_SPEED_SLOW                    1
#define POWERSTEP_SPEED_MEDIUM                  2
#define POWERSTEP_SPEED_FAST                    3
#define POWERSTEP_SPEED_VERY_FAST               4
 // powerstep_set



#define POWERSTEP_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.step = MIKROBUS( mikrobus, MIKROBUS_PWM );
 // powerstep_map // powerstep

typedef struct
{
    digital_out_t dir;          
    digital_out_t rst;          
    digital_out_t en;           
    digital_out_t step;         
 
} powerstep_t;

typedef struct
{
    pin_name_t dir;             
    pin_name_t rst;             
    pin_name_t en;              
    pin_name_t step;            
 
} powerstep_cfg_t;

typedef enum
{
    POWERSTEP_OK = 0,
    POWERSTEP_ERROR = -1
 
} powerstep_return_value_t;


void powerstep_cfg_setup ( powerstep_cfg_t *cfg );

err_t powerstep_init ( powerstep_t *ctx, powerstep_cfg_t *cfg );

void powerstep_enable_device ( powerstep_t *ctx );

void powerstep_disable_device ( powerstep_t *ctx );

void powerstep_set_direction ( powerstep_t *ctx, uint8_t dir );

void powerstep_switch_direction ( powerstep_t *ctx );

void powerstep_set_rst_pin ( powerstep_t *ctx, uint8_t state );

void powerstep_reset_device ( powerstep_t *ctx );

void powerstep_set_step_pin ( powerstep_t *ctx, uint8_t state );

void powerstep_drive_motor ( powerstep_t *ctx, uint32_t steps, uint8_t speed );
 
#ifdef __cplusplus
}
#endif
#endif // POWERSTEP_H
 // powerstep
 
// ------------------------------------------------------------------------ END